/*
 * Copyright (c) 2008-2018, Hazelcast, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hazelcast.security;

import com.hazelcast.nio.serialization.BinaryInterface;

import java.io.Serializable;

/**
 * Credentials is a container object for endpoint (Members and Clients)
 * security attributes.
 * <p/>
 * It is used on authentication process by {@link javax.security.auth.spi.LoginModule}s.
 */
@BinaryInterface
public interface Credentials extends Serializable {

    /**
     * Returns IP address of endpoint.
     *
     * @return IP address of endpoint
     */
    String getEndpoint();

    /**
     * Sets IP address of endpoint.
     *
     * @param endpoint IP address of endpoint
     */
    void setEndpoint(String endpoint);

    /**
     * Returns principal of endpoint.
     *
     * @return endpoint principal
     */
    String getPrincipal();
}
